home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / mpatrol / man / cat1 / mpatrol.1 < prev    next >
Encoding:
Text File  |  2000-05-27  |  11.4 KB  |  331 lines
  1.  
  2.  
  3.  
  4. MPATROL(1)               mpatrol library               MPATROL(1)
  5.  
  6.  
  7. NNAAMMEE
  8.        mpatrol - runs programs using the mpatrol library
  9.  
  10. SSYYNNOOPPSSIISS
  11.        mmppaattrrooll [_o_p_t_i_o_n_s] <_c_o_m_m_a_n_d> [_a_r_g_u_m_e_n_t_s]
  12.  
  13. DDEESSCCRRIIPPTTIIOONN
  14.        The mmppaattrrooll command is used to set various mpatrol library
  15.        _o_p_t_i_o_n_s when running _c_o_m_m_a_n_d with its _a_r_g_u_m_e_n_t_s.  In  most
  16.        cases,  _c_o_m_m_a_n_d  must  have  been  linked with the mpatrol
  17.        library, unless the _-_d option is used in which  case  _c_o_m_-
  18.        _m_a_n_d need only have been dynamically linked.
  19.  
  20.        All  mpatrol library diagnostics are sent to the file _m_p_a_-
  21.        _t_r_o_l_._%_n_._l_o_g in the current directory by default (where  _%_n
  22.        is  the  current process id) but this can be changed using
  23.        the --ll option.  Similarly, the  default  profiling  output
  24.        filename  is  _m_p_a_t_r_o_l_._%_n_._o_u_t.  Note that the LLOOGGAALLLL option
  25.        is always implicitly used for commands  that  are  run  by
  26.        this command.
  27.  
  28. OOPPTTIIOONNSS
  29.        All of the following options (except --dd and --VV) correspond
  30.        to their listed mpatrol library  option.   See  mmppaattrrooll(3)
  31.        for more details on these options.
  32.  
  33.        --11 <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  34.               [SSMMAALLLLBBOOUUNNDD]   Specifies  the  limit in bytes up to
  35.               which memory allocations should  be  classified  as
  36.               small allocations for profiling purposes.
  37.  
  38.        --22 <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  39.               [MMEEDDIIUUMMBBOOUUNNDD]   Specifies  the limit in bytes up to
  40.               which memory allocations should  be  classified  as
  41.               medium allocations for profiling purposes.
  42.  
  43.        --33 <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  44.               [LLAARRGGEEBBOOUUNNDD]   Specifies  the  limit in bytes up to
  45.               which memory allocations should  be  classified  as
  46.               large allocations for profiling purposes.
  47.  
  48.        --AA <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  49.               [AALLLLOOCCSSTTOOPP]  Specifies an allocation index at which
  50.               to stop the program when it is being allocated.
  51.  
  52.        --aa <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  53.               [AALLLLOOCCBBYYTTEE]  Specifies an 8-bit byte  pattern  with
  54.               which to prefill newly-allocated memory.
  55.  
  56.        --CC <_u_n_s_i_g_n_e_d _r_a_n_g_e>
  57.               [CCHHEECCKK]  Specifies a range of allocation indices at
  58.               which to check the integrity  of  free  memory  and
  59.               overflow buffers.
  60.  
  61.  
  62.  
  63.  
  64. Release 1.2                16 May 2000                          1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. MPATROL(1)               mpatrol library               MPATROL(1)
  71.  
  72.  
  73.        --cc     [CCHHEECCKKAALLLL]   Specifies  that all arguments to func-
  74.               tions which  allocate,  reallocate  and  deallocate
  75.               memory have rigorous checks performed on them.
  76.  
  77.        --DD <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  78.               [DDEEFFAALLIIGGNN]   Specifies  the  default  alignment for
  79.               general-purpose memory allocations, which must be a
  80.               power of two.
  81.  
  82.        --dd     Specifies  that programs which were not linked with
  83.               the mpatrol library should also be traced, but only
  84.               if  they were dynamically linked.  This option will
  85.               only work if the  system  dynamic  linker  has  the
  86.               ability  to  preload a set of user-specified shared
  87.               libraries via a special environment variable.
  88.  
  89.        --ee <_s_t_r_i_n_g>
  90.               [PPRROOGGFFIILLEE]  Specifies an alternative filename  with
  91.               which  to locate the executable file containing the
  92.               program's symbols.
  93.  
  94.        --FF <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  95.               [FFRREEEESSTTOOPP]  Specifies an allocation index at  which
  96.               to stop the program when it is being freed.
  97.  
  98.        --ff <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  99.               [FFRREEEEBBYYTTEE]   Specifies  an  8-bit byte pattern with
  100.               which to prefill newly-freed memory.
  101.  
  102.        --GG     [SSAAFFEESSIIGGNNAALLSS]  Instructs the library  to  save  and
  103.               replace  certain  signal handlers during the execu-
  104.               tion of library code and  to  restore  them  after-
  105.               wards.
  106.  
  107.        --gg     [UUSSEEDDEEBBUUGG]   Specifies  that any debugging informa-
  108.               tion in the  executable  file  should  be  used  to
  109.               obtain additional source-level information.
  110.  
  111.        --LL <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  112.               [LLIIMMIITT]   Specifies the limit in bytes at which all
  113.               memory allocations should fail if the  total  allo-
  114.               cated memory should increase beyond this.
  115.  
  116.        --ll <_s_t_r_i_n_g>
  117.               [LLOOGGFFIILLEE]   Specifies  an alternative file in which
  118.               to place all diagnostics from the mpatrol  library.
  119.  
  120.        --MM     [AALLLLOOWWOOFFLLOOWW]   Specifies that a warning rather than
  121.               an error should be produced if any memory operation
  122.               function overflows the boundaries of a memory allo-
  123.               cation, and that the operation should still be per-
  124.               formed.
  125.  
  126.        --mm     [UUSSEEMMMMAAPP]   Specifies  that  the library should use
  127.  
  128.  
  129.  
  130. Release 1.2                16 May 2000                          2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. MPATROL(1)               mpatrol library               MPATROL(1)
  137.  
  138.  
  139.               mmmmaapp(()) instead of ssbbrrkk(()) to allocate system memory.
  140.  
  141.        --NN     [NNOOPPRROOTTEECCTT]   Specifies  that the mpatrol library's
  142.               internal data structures should not be  made  read-
  143.               only after every memory allocation, reallocation or
  144.               deallocation.
  145.  
  146.        --nn     [NNOOFFRREEEE]  Specifies that the mpatrol library should
  147.               keep  all reallocated and freed memory allocations.
  148.  
  149.        --OO <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  150.               [OOFFLLOOWWSSIIZZEE]  Specifies the size in bytes to use for
  151.               all overflow buffers, which must be a power of two.
  152.  
  153.        --oo <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  154.               [OOFFLLOOWWBBYYTTEE]  Specifies an 8-bit byte  pattern  with
  155.               which  to  fill  the overflow buffers of all memory
  156.               allocations.
  157.  
  158.        --PP <_s_t_r_i_n_g>
  159.               [PPRROOFFFFIILLEE]  Specifies an alternative file in  which
  160.               to  place  all memory allocation profiling informa-
  161.               tion from the mpatrol library.
  162.  
  163.        --pp     [PPRROOFF]  Specifies that all memory  allocations  are
  164.               to  be  profiled  and  sent to the profiling output
  165.               file.
  166.  
  167.        --QQ <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  168.               [AAUUTTOOSSAAVVEE]  Specifies the  frequency  at  which  to
  169.               periodically  write  the profiling data to the pro-
  170.               filing output file.
  171.  
  172.        --RR <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  173.               [RREEAALLLLOOCCSSTTOOPP]  Specifies  an  allocation  index  at
  174.               which  to stop the program when a memory allocation
  175.               is being reallocated.
  176.  
  177.        --SS     [SSHHOOWWMMAAPP & SSHHOOWWSSYYMMBBOOLLSS]  Specifies  that  a  memory
  178.               map  of the entire heap and a summary of all of the
  179.               function symbols read from the program's executable
  180.               file should be displayed at the end of program exe-
  181.               cution.
  182.  
  183.        --ss     [SSHHOOWWFFRREEEEDD & SSHHOOWWUUNNFFRREEEEDD]  Specifies that a summary
  184.               of  all of the freed and unfreed memory allocations
  185.               should be displayed at the end  of  program  execu-
  186.               tion.
  187.  
  188.        --UU <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  189.               [UUNNFFRREEEEDDAABBOORRTT]   Specifies  the  minimum  number of
  190.               unfreed allocations at which to abort  the  program
  191.               just before program termination.
  192.  
  193.  
  194.  
  195.  
  196. Release 1.2                16 May 2000                          3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. MPATROL(1)               mpatrol library               MPATROL(1)
  203.  
  204.  
  205.        --VV     Displays the version number of the mmppaattrrooll command.
  206.  
  207.        --vv     [PPRREESSEERRVVEE]  Specifies that any reallocated or freed
  208.               memory  allocations  should preserve their original
  209.               contents.
  210.  
  211.        --ww     [OOFFLLOOWWWWAATTCCHH]   Specifies  that  watch  point  areas
  212.               should  be  used  for  overflow buffers rather than
  213.               filling with the overflow byte.
  214.  
  215.        --XX     [PPAAGGEEAALLLLOOCC=_U_P_P_E_R]  Specifies that  each  individual
  216.               memory  allocation  should occupy at least one page
  217.               of virtual memory and should be placed at the high-
  218.               est point within these pages.
  219.  
  220.        --xx     [PPAAGGEEAALLLLOOCC=_L_O_W_E_R]   Specifies  that each individual
  221.               memory allocation should occupy at least  one  page
  222.               of  virtual memory and should be placed at the low-
  223.               est point within these pages.
  224.  
  225.        --ZZ <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  226.               [FFAAIILLSSEEEEDD]  Specifies the random number seed  which
  227.               will  be used when determining which memory alloca-
  228.               tions will randomly fail.
  229.  
  230.        --zz <_u_n_s_i_g_n_e_d _i_n_t_e_g_e_r>
  231.               [FFAAIILLFFRREEQQ]  Specifies the frequency  at  which  all
  232.               memory allocations will randomly fail.
  233.  
  234. SSEEEE AALLSSOO
  235.        mmlleeaakk(1), mmpprrooff(1), mmppaattrrooll(3).
  236.  
  237.        The mpatrol manual, reference card and FAQ.
  238.  
  239.        http://www.cbmamiga.demon.co.uk/mpatrol/
  240.  
  241. AAUUTTHHOORR
  242.        Graeme S. Roy <graeme@epc.co.uk>
  243.  
  244. CCOOPPYYRRIIGGHHTT
  245.        Copyright (C) 1997-2000 Graeme S. Roy <graeme@epc.co.uk>
  246.  
  247.        This  library  is  free  software; you can redistribute it
  248.        and/or modify it under the terms of the GNU  Library  Gen-
  249.        eral  Public  License  as  published  by the Free Software
  250.        Foundation; either version 2 of the License, or  (at  your
  251.        option) any later version.
  252.  
  253.        This  library  is  distributed in the hope that it will be
  254.        useful, but WITHOUT ANY WARRANTY; without even the implied
  255.        warranty  of  MERCHANTABILITY  or FITNESS FOR A PARTICULAR
  256.        PURPOSE.  See the GNU Library General Public  License  for
  257.        more details.
  258.  
  259.  
  260.  
  261.  
  262. Release 1.2                16 May 2000                          4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. MPATROL(1)               mpatrol library               MPATROL(1)
  269.  
  270.  
  271.        You should have received a copy of the GNU Library General
  272.        Public License along with this library; if not,  write  to
  273.        the Free Software Foundation, Inc., 59 Temple Place, Suite
  274.        330, Boston, MA 02111-1307, USA.
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328. Release 1.2                16 May 2000                          5
  329.  
  330.  
  331.